Update Control Plane link #477
Conversation
WalkthroughThe change involves updating a hyperlink in the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (28)
README.md (28)
Line range hint
37-37: Use a comma before ‘and’ if it connects two independent clauses.- ...the webpacker to shakapacker upgrades and it all seems to be running smoothly! + ...the webpacker to shakapacker upgrades, and it all seems to be running smoothly!
Line range hint
39-39: Consider replacing "very easy" with a more precise term.- ...it was now also very easy for me to upgrade Tailwind and include... + ...it was now also straightforward for me to upgrade Tailwind and include...
Line range hint
39-39: Use a hyphen in "node_module-based".- ...our external node_module based web component library which we were using... + ...our external node_module-based web component library which we were using...
Line range hint
39-39: Use ‘will’ instead of ‘going to’ for certainty.- ...That work is going to be shipped later this week though as we... + ...That work will be shipped later this week though as we...
Line range hint
41-41: Use a comma before ‘and’ if it connects two independent clauses.- ...polishing the last bits of it. 😉 Have a great 2023 and maybe we get to work together again later in the year! 🙌 + ...polishing the last bits of it. 😉 Have a great 2023, and maybe we get to work together again later in the year! 🙌
Line range hint
58-58: Remove duplicate "View Helpers" in the table of contents.- ...View Helpers](#view-helpers) - [View Helpers `javascript_pack_tag` and `stylesheet_pack_tag`](#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag) + ...View Helpers](#view-helpers) - [`javascript_pack_tag` and `stylesheet_pack_tag`](#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag)
Line range hint
109-109: Ensure the list item is correctly formatted.- ...[PNPM](https://pnpm.io/), and [Bun](https://bun.sh/) + ...[PNPM](https://pnpm.io/), and [Bun](https://bun.sh/)]
Line range hint
127-127: Add "the" before "below Manual Installation Steps".- ...and follow below Manual Installation Steps to manually add the `shakapacker` gem to your Gemfile. + ...and follow the below Manual Installation Steps to manually add the `shakapacker` gem to your Gemfile.
Line range hint
147-147: Add a comma before "or use theFORCE=trueenvironment variable".- ...for overriding these files or use the `FORCE=true` environment variable before the installation command to force the override without any prompt. + ...for overriding these files, or use the `FORCE=true` environment variable before the installation command to force the override without any prompt.
Line range hint
159-159: Use "installed" instead of "install".- ...ensure that the desired package manager is actually install at the right version, which can be done... + ...ensure that the desired package manager is actually installed at the right version, which can be done...
Line range hint
195-195: Rephrase to avoid repetition of "provide".- ...Provide a community-supported, default webpack compilation that generates the necessary bundles and manifest, using the same configuration file. This compilation can be extended for any needs. + ...Offer a community-supported, default webpack compilation that generates the necessary bundles and manifest, using the same configuration file. This compilation can be extended for any needs.
Line range hint
236-236: Add a comma before "as that would break the browser caching".- ...disable the content hash for a `NODE_ENV` of production as that would break the browser caching of assets. + ...disable the content hash for a `NODE_ENV` of production, as that would break the browser caching of assets.
Line range hint
391-391: Rephrase to avoid repetition of "If you want to".- ...View Helper: `favicon_pack_tag` If you want to create a favicon: + ...View Helper: `favicon_pack_tag` To create a favicon:
Line range hint
397-397: Rephrase to avoid repetition of "If you want to".- ...View Helper: `preload_pack_asset` If you want to preload a static asset in your `<head>`... + ...View Helper: `preload_pack_asset` To preload a static asset in your `<head>`...
Line range hint
404-404: Rephrase to avoid repetition of "If you want to".- ...Images in Stylesheets If you want to use images in your stylesheets: + ...Images in Stylesheets To use images in your stylesheets:
Line range hint
439-439: Correct "By default" capitalization.- ...config file. By default `mtime` strategy is used in development... + ...config file. By default, `mtime` strategy is used in development...
Line range hint
467-467: Use "revert" instead of "revert back".- ...detect that it's not running and Rails will revert back to on-demand compilation _if_ you have the `compile` option set to true in your `config/shakapacker.yml` + ...detect that it's not running and Rails will revert to on-demand compilation _if_ you have the `compile` option set to true in your `config/shakapacker.yml`
Line range hint
494-494: Add a comma before "which the view helpers also use".- ...that reads the `config/shakapacker.yml` file which the view helpers also use. If you have your customized webpack configuration, at the minimum, you must ensure: + ...that reads the `config/shakapacker.yml` file, which the view helpers also use. If you have your customized webpack configuration, at the minimum, you must ensure:
Line range hint
610-610: Add "to" before "opt-in".- ...Please note that if you want opt-in to use SWC, you can skip [React](#react) integration instructions as it is supported out of the box. + ...Please note that if you want to opt-in to use SWC, you can skip [React](#react) integration instructions as it is supported out of the box.
Line range hint
620-620: Add a comma before "install relevant packages".- ...To enable support for CoffeeScript or TypeScript install relevant packages: + ...To enable support for CoffeeScript or TypeScript, install relevant packages:
Line range hint
761-761: Add a comma after "for example".- ...guide/) For example to add Vue support: + ...guide/) For example, to add Vue support:
Line range hint
795-795: Add a comma before "however".- ...environments in `config/shakapacker.yml` however, in most production apps extra environments are needed as part of the deployment workflow. + ...environments in `config/shakapacker.yml`, however, in most production apps extra environments are needed as part of the deployment workflow.
Line range hint
876-876: Add a comma after "Therefore".- ...entry points, as webpack calls it). Therefore you don't want to put any file inside `app/javascript` directory that you do not want to be an entry file. + ...entry points, as webpack calls it). Therefore, you don't want to put any file inside `app/javascript` directory that you do not want to be an entry file.
Line range hint
878-878: Rephrase to avoid repetition of "Suppose you want to".- ...javascript/controllers`. Suppose you want to change the source directory from `app/javascript` to `frontend` and output to `assets/packs`. This is how you would do it: + ...javascript/controllers`. To change the source directory from `app/javascript` to `frontend` and output to `assets/packs`, do the following:
Line range hint
917-917: Add a comma before "just like with thesource_path".- ...folders will also have their path stripped just like with the `source_path`. + ...folders will also have their path stripped, just like with the `source_path`.
Line range hint
923-923: Separate "otherwise" from the sentence.- ...paths here otherwise it will make the compilation slow, consider adding specific paths instead of the whole parent directory if you just need to reference one or two modules + ...paths here; otherwise, it will make the compilation slow. Consider adding specific paths instead of the whole parent directory if you just need to reference one or two modules.
Line range hint
930-930: Add a comma before "similar to sprockets".- ...to `assets:precompile`. Similar to sprockets both rake tasks will compile packs in production mode but will use `RAILS_ENV` to load configuration from `config/shakapacker.yml` (if available). + ...to `assets:precompile`. Similar to sprockets, both rake tasks will compile packs in production mode but will use `RAILS_ENV` to load configuration from `config/shakapacker.yml` (if available).
Line range hint
973-973: Use a hyphen in "open-source".- ...The following companies support our Open Source projects, and ShakaCode uses their products! + ...The following companies support our open-source projects, and ShakaCode uses their products!
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional Context Used
LanguageTool (28)
README.md (28)
Near line 37: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ed the webpacker to shakapacker upgrades and it all seems to be running smoothly! Th...
Near line 39: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... > On top of your work, it was now also very easy for me to upgrade Tailwind and include ...
Near line 39: This expression is usually spelled with a hyphen.
Context: ... Tailwind and include our external node_module based web component library which we were usi...
Near line 39: Use ‘will’ instead of ‘going to’ if the following action is certain.
Context: ...r (more modern) apps already. That work is going to be shipped later this week though as we...
Near line 41: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ast bits of it. 😉 > > Have a great 2023 and maybe we get to work together again lat...
Near line 58: This phrase is duplicated. You should probably use “View Helpers” only once.
Context: ...d Code](#configuration-and-code) - View Helpers - [View Helpersjavascript_pack_tagand `stylesheet_p...
Near line 109: Unpaired symbol: ‘]’ seems to be missing
Context: ...tarted)), PNPM, and Bun - [Webpack v5+](ht...
Near line 127: Possible missing article found.
Context: ...kip JavaScript for a new app and follow below Manual Installation Steps to manually a...
Near line 147: Possible missing comma found.
Context: ...ve all the prompts for overriding these files or use theFORCE=trueenvironment var...
Near line 159: Consider using either the past participle “installed” or the present participle “installing” here.
Context: ...the desired package manager is actually install at the right version, which can be done...
Near line 195: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... splitting, fingerprinting, and HMR. 3. Provide a community-supported, default webpack ...
Near line 236: Possible missing comma found.
Context: ...le the content hash for aNODE_ENVof production as that would break the browser caching...
Near line 391: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... View Helper:favicon_pack_tagIf you want to create a favicon: ```erb <%= favicon_pa...
Near line 397: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...iew Helper:preload_pack_assetIf you want to preload a static asset in your<head>...
Near line 404: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...### Images in Stylesheets If you want to use images in your stylesheets:css...
Near line 439: Did you mean: “By default,”?
Context: ...ption inshakapacker.ymlconfig file. By defaultmtimestrategy is used in development...
Near line 467: Consider using just “revert”.
Context: ...ct that it's not running and Rails will revert back to on-demand compilation if you have ...
Near line 494: Possible missing comma found.
Context: ...that reads theconfig/shakapacker.ymlfile which the view helpers also use. If you...
Near line 610: Possible missing preposition found.
Context: ...ader.md). Please note that if you want opt-in to use SWC, you can skip [React](#re...
Near line 620: Possible missing comma found.
Context: .... To enable support for CoffeeScript or TypeScript install relevant packages: #### React ...
Near line 761: After the expression ‘for example’ a comma is usually used.
Context: ...tps://vue-loader.vuejs.org/guide/) For example to add Vue support: ```js // config/web...
Near line 795: Consider inserting a comma before ‘however’.
Context: ...nt, test and production environments inconfig/shakapacker.ymlhowever, in most production apps extra environme...
Near line 876: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...(or entry points, as webpack calls it). Therefore you don't want to put any file inside `...
Near line 878: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...p/javascript/controllers. Suppose you want to change the source directory fromapp/j...
Near line 917: Possible missing comma found.
Context: ...these folders will also have their path stripped just like with thesource_path. Exam...
Near line 923: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...:** Please be careful when adding paths here otherwise it will make the compilation slow, cons...
Near line 930: Possible missing comma found.
Context: ...ased toassets:precompile. Similar to sprockets both rake tasks will compile packs in p...
Near line 973: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...rs The following companies support our Open Source projects, and ShakaCode uses their prod...
Additional comments not posted (1)
README.md (1)
988-988: Update Control Plane link to the correct URL.The link has been correctly updated to
https://shakacode.controlplane.com.
Summary
Updates the README so the Control Plane link goes to our landing page.
Summary by CodeRabbit
https://shakacode.controlplane.cominstead ofhttps://controlplane.com.